Release 10.1A: OpenEdge Development:
Java Open Clients

Purposed property accessor methods for RunTimeProperties class and Connection objects

In addition to the general property accessor methods, you can access properties using individual property accessor methods. Every property has a pair of methods you can use to set and get the value of the property.

When calling these methods on the RunTimeProperties class, use the class name to call the method. For example:

RunTimeProperties.setInitialConnections(5);

When calling these methods on a Connection object, use the instance of the object to call the method. For example:

ConnectObj.setInitialConnections(5);

Where ConnectObj is an instance of the com.progress.open4gl.javaproxy.Connection class.

Session methods

Table 7–2 lists the session property methods. For a detailed description of each property, see the "Alphabetical listing of properties" section.

Table 7–2: Session methods

Method	Description
setSessionMode(int sessionModel)	Sets PROGRESS.Session.sessionModel.
getSessionModel()	Gets PROGRESS.Session.sessionModel.
setInitialConnections   (int nInitialConnections)	Sets PROGRESS.Session.initialConnections.
getInitialConnections()	Gets PROGRESS.Session.initialConnections.
setMaxConnections(int nMaxConnections)	Sets PROGRESS.Session.maxConnections.
getMaxConnections()	Gets PROGRESS.Session.maxConnections.
setMinConnections(int nMinConnections)	Sets PROGRESS.Session.minConnections.
getMinConnections()	Gets PROGRESS.Session.minConnections.
setIdleConnectionTimeout(int nTimeoutSec)	Sets PROGRESS.Session.idleConnectionTimeout.
getIdleConnectionTimeout()	Gets PROGRESS.Session.idleConnectionTimeout.
setConnectionLifetime   (int nConnectionLifetimeSec)	Sets PROGRESS.Session.connectionLifetime.
getConnectionLifetime()	Gets PROGRESS.Session.connectionLifetime.
setNsClientMinPort(int nMinPortNum)	Sets PROGRESS.Session.nsClientMinPort.
getNsClientMinPort()	Gets PROGRESS.Session.nsClientMinPort.
setNsClientMaxPort(int nMaxPortNum)	Sets PROGRESS.Session.nsClientMaxPort.
getNsClientMaxPort()	Gets PROGRESS.Session.nsClientMaxPort.
setNsClientPortRetry(int nRetries)	Sets PROGRESS.Session.nsClientPortRetry.
getNsClientPortRetry()	Gets PROGRESS.Session.nsClientPortRetry.
setNsClientPortRetryInterval(int nDelayMs)	Sets PROGRESS.Session.nsClientPortRetryInterval.
getNsClientPortRetryInterval()	Gets PROGRESS.Session.nsClientPortRetryInterval.
setNsClientPicklistSize(int nPickListSize)	Sets PROGRESS.Session.nsClientPicklistSize.
getNsClientPicklistSize()	Gets PROGRESS.Session.nsClientPicklistSize.
setNsClientPicklistSize    (int nPickListExpiration)	Sets PROGRESS.Session.nsClientPicklistExpiration.
getNsClientPicklistExpiration()	Gets PROGRESS.Session.nsClientPicklistExpiration.
setRequestWaitTimeout(int nRqWaitSec)	Sets PROGRESS.Session.requestWaitTimeout.
getRequestWaitTimeout()	Sets PROGRESS.Session.requestWaitTimeout.

Thread control methods

The AppServer can be accessed from a multi-threaded client. However, the AppServer itself is not multi-threaded. As a result, only one request is serviced at a time. If a method call is made from the client while another one is still running on the AppServer, the application can decide which of the following should happen:

The second call can be queued and executed when the AppServer becomes available.
The client can get a Java exception.

The application can set the run-time properties to do either and can switch the setting at any time. The default is to throw an exception (WaitIfBusy=false).

The methods in Table 7–3 provide thread control to the Open Client Runtime. For a detailed description of each property, see the "Alphabetical listing of properties" section.

Table 7–3: Thread control methods

Method	Description/Property
setWaitIfBusy()	Sets PROGRESS.Session.waitIfBusy to true.
setNoWaitIfBusy()	Sets PROGRESS.Session.waitIfBusy to false.
getWaitIfBusy()	Gets PROGRESS.Session.waitIfBusy. Returns TRUE if setWaitIfBusy() was called; FALSE, if setNoWaitIfBusy() was called.

Proxy server specification methods

You use proxy server specification methods if a Proxy Web server exists between the client and the Web server hosting the AppServer Internet Adapter (AIA).

The methods in Table 7–4 provide Proxy Web server support to a Java Open Client application. For a detailed description of each property, see the "Alphabetical listing of properties" section.

Table 7–4: Proxy server specification methods

Method	Description
setProxyHost(String hostname)	Sets PROGRESS.Session.proxyHost.
getProxyHost()	Gets PROGRESS.Session.proxyHost.
setProxyPort(int port)	Sets PROGRESS.Session.proxyPort.
getProxyPort()	Gets PROGRESS.Session.proxyPort.
setProxyUserid(String userid)	Sets PROGRESS.Session.proxyUserId.
getProxyUserId()	Gets PROGRESS.Session.proxyUserId.
setProxyPassword(String password)	Sets PROGRESS.Session.proxyPassword.
getProxyPassword()	Gets PROGRESS.Session.proxyPassword.

Secure Sockets Layer management methods

When using HTTPS to access the AppServer, you must supply digital certificates with your client application.

The methods in Table 7–5 provide digital certificate management to the Open Client application. For a detailed description of each property, see the "Alphabetical listing of properties" section.

Table 7–5: Secure Sockets Layer management methods 

Method	Description
setCertificateStore   (String certStoreList)	Sets PROGRESS.Session.certificateStore.
getCertificateStore()	Gets PROGRESS.Session.certificateStore.
setNoHostVerify(boolean verify)	Sets PROGRESS.Session.noHostVerify.
getNoHostVerify()	Gets PROGRESS.Session.noHostVerify.
setnoSslSessionReuse(boolean verify)	Sets PROGRESS.Session.noSslSessionReuse.
getnoSslSessionReuse()	Gets PROGRESS.Session.noSslSessionReuse.

Tracing methods (RunTimeProperties only)

Tracing logs highlights of proxy execution, including data received by the client and data passed to the AppServer. The methods in Table 7–6 provide tracing functionality to the Open Client application. These methods apply to the RunTimeProperties class only. (They do not apply to Connection objects.) For a detailed description of each property, see the "Relationship between the RunTimeProperties class and Connection objects" section.

Table 7–6: Tracing methods

Method	Description
traceOn(String filename, int level)	Sets these properties: PROGRESS.Session.enableTracing PROGRESS.Session.logFileName PROGRESS.Session.loggingLevel
traceOn(int level)	Sets these properties: PROGRESS.Session.enableTracing PROGRESS.Session.loggingLevel
traceOn(String filename)	Sets these properties: PROGRESS.Session.enableTracing PROGRESS.Session.logFileName
traceOn()	Sets PROGRESS.Session.enableTracing.
traceOff()	Sets PROGRESS.Session.enableTracing.
isTracing()	Gets PROGRESS.Session.enableTracing.